Skip to content

docs: add data flags comparison to attestations page#172

Merged
jumboduck merged 4 commits intomainfrom
docs/171-attest-data-flags-comparison
Apr 24, 2026
Merged

docs: add data flags comparison to attestations page#172
jumboduck merged 4 commits intomainfrom
docs/171-attest-data-flags-comparison

Conversation

@dangrondahl
Copy link
Copy Markdown
Contributor

@dangrondahl dangrondahl commented Apr 23, 2026

Summary

  • Adds an "Attaching data to attestations" section to getting_started/attestations.md explaining the difference between --user-data, --attachments, and --attestation-data
  • Includes a comparison table and usage examples for each flag
  • Placed between the existing "Evidence Vault" and "Attestation types" sections

Closes #171

@dangrondahl dangrondahl requested a review from a team as a code owner April 23, 2026 07:52
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented Apr 23, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Apr 23, 2026, 7:53 AM

Adds an "Attaching data to attestations" section explaining the
difference between --user-data, --attachments, and --attestation-data
with a comparison table and usage examples.

Closes #171
- Change "All attest commands" to "All evidence attest commands"
- Remove "queryable" claim for --user-data
- Add --flow and --trail to code examples for consistency
- Note comma-separated syntax for --attachments
- Add cross-link to Custom attestation type section
The server enforces a 10MB limit on all attestation request payloads.
This applies to --user-data, --attachments, and --attestation-data
combined. Mentions --external-url as the alternative for larger files.
The 10MB limit only applies to file uploads (multipart/form-data),
not to JSON body fields like --user-data and --attestation-data.
Removing rather than documenting incorrect limits.
@jumboduck jumboduck merged commit 46836ec into main Apr 24, 2026
4 checks passed
@jumboduck jumboduck deleted the docs/171-attest-data-flags-comparison branch April 24, 2026 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add data flags comparison to getting started attestations page

2 participants